Account Settings - Custom Fields
Custom fields in Liveclicker are one of the ways in which Liveclicker elements can be customized with data available in the ESP.
Custom fields can be:
-
Specific to a type of element — These are pre-defined custom fields, pre-baked into the solution, and include the Subscriber ID as well as the custom fields for LiveMap, LiveForecast, LiveTimer and LiveTracker. These specific custom fields do not only allow personalization and refinement of targeting rules, but are also required to ensure full functionality when using these elements.
-
Generic — These are manually configured by the user. You can define up to 20 generic custom fields and these can be used for personalization, in targeting rules, A/B testing, reports, etc.
Subscriber ID
The Subscriber ID is the unique identification of the recipient of the email message and when configured, it is incorporated by default in every Liveclicker element embed code.
Although Subscriber IDs are not necessary for all Liveclicker elements, Subscriber IDs are crucial for accurate opener-level reporting on your campaigns as well as for targeting and click-through URLs.
For optimal results, Liveclicker recommends the use of Subscriber IDs in all campaigns. This is because a Subscriber ID is a value that's unique to each opener.
For more information on the Subscriber ID, where and how it is used, and how to create these, please refer to the Subscriber IDs topic.
Liveclicker Element Specific Custom Fields
These element specific Custom fields are required for a correct use and execution of the element.
To access the element specific custom fields, click the corresponding tabs:
The default Custom fields are listed. The field names cannot be edited as they are used as such in element specific features. Map the Custom fields to the corresponding tags in your ESP. If you do not know how these tags are referenced in the ESP, contact your ESP.
Example:
- ESP = Marigold Engage : [%[Table_Name.Field_Name]%] where Table_Name can be MASTER to reference the Audience List or the name of the profile extension.
- ESP = Engage by Sailthru: {profile.vars.first_name}.
- ESP= Engage+: {(email)}, {(firstname)}, {(country)}
LiveMap
Map Location — Used in LiveMaps when users want to load a map based on a custom location stored in the ESP
Example: A DIY shop wants to show promotions in the store closest to the home location of the opener, and not closest to the opener's current location.
(For an overview of supported location formats, please check this topic.
Store ID — Used in LiveMaps when users want to load a map based on the ID of a specific store location. Note that in this case you need to have the StoreID as a column in your Location dataset.
Example: If you know your customer has a preferred store, which isn't necessarily their closest store, you can use the Store ID to pinpoint this instead of their nearest store.
Note: LiveMap custom fields are also required when creating targeting rules based on location!
LiveForecast
The LiveForecast Custom fields allow you to provide weather forecasts using the opener's data in the ESP and as such customize the forecast using the ESP location and arrival date instead of the opener's current location.
Destination city — Used in LiveForecast when the forecast needs to be loaded using the recipient's custom ESP location.
Arrival date — Used in LiveForecast to load a custom start date for a recipient's forecast.
LiveTimer
The LiveTimer elements allows to count down to a set date and time, such as the end of the free delivery period, start of the ticket sale, Christmas,.... This countdown can be configured to be a set date and time, or you can decide to make it dependent on the opener. In this case, a Custom field needs to be configured that gets this information from your ESP.
LiveTimer Expiration — Used in LiveTimers when users want to specify a personalized expiration date for every recipient's timer. Use the following syntax for the ESP tag: %%expiration%% .
Following is an overview of the accepted date/time formats for this field:
Accepted Format | Result |
---|---|
YYYY-MM-DD HH:MM:SS | 2020-01-07 15:00:00 |
M/D/YYYY H:MM AM/PM | 4/24/2020 6:30 AM |
YYYYMMDD HHMMSS | 20200313 153000 |
DD-MM-YYYY HH:MM:SS | 31-08-2020 13:30:00 |
In addition to using a Custom field to customize the expiration date, there are additional ways to customize the expiration date even more. They are listed below.
Adding an extension to the expiration date
In addition to using a customized expiration date, you can also go one step further and add an extension to this expiration date. Use the following syntax to do so: %%expiration%% plus 2 days. Below you'll find some examples:
Use case | Format |
---|---|
1 day after the date passed | %%expiration%% plus 1 day |
2 days and 30 minutes after the date passed | %%expiration%% plus 2 days, 30 minutes |
1 day, 4 hours, and 30 minutes after the date passed | %%expiration%% plus 1 day, 4 hours, 30 minutes |
For example, if you want to expire your timer 2 days and 30 minutes after the ESP expiration date, you would set up your LiveTimer Expiration field as follows:
Customize the expiration date by open time
With this functionality, you can automatically expire the countdown timer within a set period of time after first opening the campaign. Use the following format:
Accepted Format | Result |
---|---|
first_open plus X day/s | first_open plus 2 days |
first_open plus X hour/s | first_open plus 6 hours |
first_open plus X minute/s | first_open plus 10 minutes |
For example, if you want to expire your timer 3 days after a subscriber's first open, you would set up your LiveTimer Expiration field as follows:
Reset the expiration date every 24 hours
Use the following format:
Accepted Format | Result |
---|---|
HH:MM:SS | 16:00:00 |
For example, if you want your timer to expire every day at 4 PM, you would set up your LiveTimer Expiration field as follows:
Reset the expiration date every week
Use the following format:
Accepted Format | Result |
---|---|
Day-of-week HH:MM:SS | Sunday 16:00:00 |
For example, if you want your timer to expire every Sunday at 4 PM, you would set up your LiveTimer Expiration field as follows:
Important note: If you run multiple LiveTimer campaigns each with their own personalized expiration, you need to execute the following steps to ensure the embed code for each of these LiveTimer campaigns is generated correctly, using the correct expiration setting:
1) Save the LiveTimer expiration field as desired for your campaign in your Account Settings.
2) Go to the campaign and select the Embed Code tab to retrieve the campaign embed code.
3) Go back to your Account Settings and change the expiration field for the next campaign.
4) Refresh the Embed Code page for the next campaign and retrieve the campaign embed code of the campaign and repeat the process as necessary.
LiveTracker
In order for a LiveTracker element to be able to use the auto-detect function for the shipping provider, you must set up LiveTracker specific custom fields for your Shipping provider and Tracking number here.
The way the custom fields work is that Liveclicker uses the ESP tag to look up the tracking number and deliver the correct shipping provider's information by reading the provider pulled from this custom field. Both custom fields work together and need to be filled out.
Tracking Number — Use this field to pass the tracking number used in the LiveTracker element to show the real-time status of the opener’s shipment. Enter the ESP's variable code to identify an opener's tracking number.
Note: If you have multiple tracking numbers, separate the different tracking numbers in the ESP variable using a ; for example.
Shipping Provider — Use this field to pass the shipping provider used in the LiveTracker element to auto-detect the correct shipping provider to look up an opener’s tracking number. Below you can find an overview of supported shipping providers and the accepted formats and possible shipment status.
Shipping Provider | Accepted Formats | Status types |
---|---|---|
USPS | "usps" |
* Pre-shipping * In transit * Delivered * Out for Delivery |
UPS | "ups" | * Pre-shipping * In transit * Delivered |
TNT | "tnt" | * Pre-shipping * In transit * Delivered |
FedEx | "fedex" | * Pre-shipping * In transit * Delivered |
DHL (US only) | "dhl" | * Pre-shipping * In transit * Delivered |
OnTrac | "ontrac" |
* Pre-shipping * In transit * Delivered * Out for delivery * Delayed and Delivered |
Canada Post | "canada_post" | * Pre-shipping * In transit * Delivered |
Globegistics | "globegistics" | * Pre-shipping * In transit * Delivered |
Generic Custom Fields
In the Custom ESP Fields section, you can set up 20 different custom fields (please contact support if you need more than 20). To set up a Custom ESP Field, you simply input the friendly name of the field and the ESP variable tag you want to use for each field.
Example, "%%gender%% might be the variable code from your ESP that you would like to use for a custom "Gender" field.
Custom fields can be used in various locations:
-
Personalized targeting rules
-
Personalized reports — Every custom field can be used as a breakdown level in a report
-
Personalized clickthrough URLs
-
Personalized overlay text in images